RecordOwner
The RecordOwner element is the parent node for each record owner or record owner group. Nested within the RecordOwner tag are elements that define the record owner or record owner group information, time data records and time data values for the historical or forecast input data. This element is optional but the input file should contain at least one RecordOwner element.
The required attribute id specifies a unique ID value that corresponds to a CygNet record owner or record owner group facility record in the configured FAC service.
Note:
The terms "Input Owner" and "Record Owner" are used interchangeably throughout the ELF system and in this documentation. See External Input Data Import for more information about this entity. The input XML file uses RecordOwner and RecordOwners elements.
Data Formats for Historical or Forecast Input Data
There are two data format options for importing historical and forecast input data into the ELF system for a record owner: by time data records or by item data records. A single RecordOwner element may contain data values in one or the other format, but not in both formats. Select the data format that best suits your needs and source data. You can include multiple RecordOwner elements in an input data XML file. See the descriptions for each data type element below:
- TimeDataRecords and TimeDataRecord and TimeDataValue
- ItemDataRecords and ItemDataRecord and ItemDataValue
Properties
| Property | Description |
|---|---|
|
Case Sensitive |
Yes |
|
Required |
No |
|
Number of Instances Allowed |
Unlimited |
|
Requires End Tag |
Yes |
|
Parent Element |
|
|
Child Elements |
|
|
Attributes |
id |
* Child elements can be in the form of TimeDataRecords or ItemDataRecords but not both.
Attributes
| Attribute | Required | Description | Value Options |
|---|---|---|---|
|
id |
Yes |
Specifies a unique ID value that corresponds to a CygNet record owner or record owner group facility record in the configured FAC service. |
String (in quotes). The value of the id attribute will be copied into a facility record attribute for the record owner or record owner group facility record in the configured FAC service. That particular attribute will be user-configurable in the ELF device configuration, so depending on the facility attribute configured for the External ID, the length of this string will be constrained by the length of that attribute. For example, if you have configured Facility Attribute 2, the string is limited to 20 characters; if you have configured Facility Attribute 3, the string is limited to 40 characters; if you have configured Facility Attribute 6, the string is limited to 60 characters; etc. See Attribute Names and Lengths. |
If a unique ID is specified in the import file, the ELF driver assumes that the required facility has already been created and configured. If the facility does not exist, import errors will be generated and the particular import for the missing record owner or record owner group will fail.
Example
|
<RecordOwner id="Port of Houston TX"> <OwnerDescription>Port of Houston</OwnerDescription> <GroupID>Texas</GroupID> <TimeDataRecords> <TimeDataRecord start_time="2024-01-01T00:00:00.000-08:00" end_time="2024-01-01T01:00:00.000-08:00"> <TimeDataValue type="AVTEMP" units="F">53.1</TimeDataValue> <TimeDataValue type="DEWPOINT" units="F">25.5</TimeDataValue> <TimeDataValue type="PRESSURE" units="inH2O">30.33</TimeDataValue> . . . <TimeDataValue type="RADIATION" units="watts/m2">32767</TimeDataValue> </TimeDataRecord> </TimeDataRecords> </RecordOwner> |
